Skip to content

Document breaking changes in v0.4.0 #2154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 8, 2025
Merged

Document breaking changes in v0.4.0 #2154

merged 1 commit into from
Jul 8, 2025

Conversation

DouweM
Copy link
Contributor

@DouweM DouweM commented Jul 8, 2025

See #1799 - Pydantic Evals EvaluationReport and ReportCase are now generic dataclasses instead of Pydantic models. If you were serializing them using model_dump(), you will now need to use the EvaluationReportAdapter and ReportCaseAdapter type adapters instead.

See #1507 - The ToolDefinition description argument is now optional and the order of positional arguments has changed from name, description, parameters_json_schema, ... to name, parameters_json_schema, description, ... to account for this.

@DouweM DouweM self-assigned this Jul 8, 2025
Copy link
Contributor

hyperlint-ai bot commented Jul 8, 2025

PR Change Summary

Documented breaking changes in version 0.4.0 of PydanticAI, including updates to dataclass usage and argument order in ToolDefinition.

  • Updated EvaluationReport and ReportCase to be generic dataclasses instead of Pydantic models.
  • Introduced EvaluationReportAdapter and ReportCaseAdapter for serialization.
  • Made the description argument in ToolDefinition optional and changed the order of positional arguments.

Modified Files

  • docs/changelog.md

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

Copy link

github-actions bot commented Jul 8, 2025

Docs Preview

commit: eeac1b4
Preview URL: https://13f5306e-pydantic-ai-previews.pydantic.workers.dev

@DouweM DouweM merged commit 11d1cde into main Jul 8, 2025
19 checks passed
@DouweM DouweM deleted the 0-4-0-breaking-changes branch July 8, 2025 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant